Package com.cisco.pt.ipc.sim.impl
Class PTPPortDataImpl
java.lang.Object
com.cisco.pt.ipc.impl.IPCObjectImpl
com.cisco.pt.ipc.sim.impl.PTPPortDataImpl
- All Implemented Interfaces:
IPCObject,PTPPortData
Information provided by the PKI file:
\class PTPPortData
\brief This file holds CPTPPortData class declaration.
\example IpcBase::cast<SwitchPort>(network().getDevice("Switch0").getPort("FastEthernet0/1")).getPtpPortData();
- Author:
- Auto-generated
-
Field Summary
Fields inherited from class com.cisco.pt.ipc.impl.IPCObjectImpl
accessMessage, ipcFactory, packetTracerSession -
Constructor Summary
ConstructorsConstructorDescriptionPTPPortDataImpl(IPCFactory ipcFactory, PacketTracerSession packetTracerSession, IPCMessageLTV accessMessage) -
Method Summary
Modifier and TypeMethodDescriptionvoidInformation provided by the PKI file:voidInformation provided by the PKI file:voidInformation provided by the PKI file:intInformation provided by the PKI file:intInformation provided by the PKI file:doubleInformation provided by the PKI file:Information provided by the PKI file:intInformation provided by the PKI file:intInformation provided by the PKI file:doubleInformation provided by the PKI file:doubleInformation provided by the PKI file:Information provided by the PKI file:Information provided by the PKI file:intInformation provided by the PKI file:Information provided by the PKI file:intInformation provided by the PKI file:intInformation provided by the PKI file:doubleInformation provided by the PKI file:intInformation provided by the PKI file:voidInformation provided by the PKI file:voidInformation provided by the PKI file:booleanInformation provided by the PKI file:booleanInformation provided by the PKI file:booleanremoveForeignMasterBySrcPortId(String uuid, int portNum) Information provided by the PKI file:voidInformation provided by the PKI file:voidsetAnnounceInterval(int num) Information provided by the PKI file:voidsetAnnounceReceiptTimeout(int num) Information provided by the PKI file:voidsetAnnounceSeqNum(double num) Information provided by the PKI file:voidsetBustEnabled(boolean enable) Information provided by the PKI file:voidsetDecisionCode(DecisionCode code) Information provided by the PKI file:voidsetDelayReqCounter(int num) Information provided by the PKI file:voidsetDelayRequestInterval(int num) Information provided by the PKI file:voidsetEBestSrc(boolean value) Information provided by the PKI file:voidsetLastGeneralEventSeqNum(double num) Information provided by the PKI file:voidsetLastSyncSeqNum(double num) Information provided by the PKI file:voidsetPortState(PortState state) Information provided by the PKI file:voidsetPtpVersion(int num) Information provided by the PKI file:voidsetRecommendedPortState(PortState state) Information provided by the PKI file:voidsetSyncInterval(int num) Information provided by the PKI file:voidsetSyncMsgCounter(int value) Information provided by the PKI file:voidsetSyncSeqNum(double num) Information provided by the PKI file:voidsetSyncWaitLimit(long num) Information provided by the PKI file:Methods inherited from class com.cisco.pt.ipc.impl.IPCObjectImpl
getAccessMessage, getClassName, getFactory, getObjectUUID, getPacketTracerSession, sendMessage, sendMessageWithReturn, translateToCommandStatusStringPairMethods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitMethods inherited from interface com.cisco.pt.ipc.IPCObject
getAccessMessage, getClassName, getFactory, getObjectUUID, getPacketTracerSession
-
Constructor Details
-
PTPPortDataImpl
public PTPPortDataImpl(IPCFactory ipcFactory, PacketTracerSession packetTracerSession, IPCMessageLTV accessMessage)
-
-
Method Details
-
setPtpVersion
public void setPtpVersion(int num) Information provided by the PKI file:
\brief Sets ptp version. \param num, version number to use.- Specified by:
setPtpVersionin interfacePTPPortData- Parameters:
num- Takes in a parameter of num
-
getPtpVersion
public int getPtpVersion()Information provided by the PKI file:
\brief Gets ptp version. \return int, version number.- Specified by:
getPtpVersionin interfacePTPPortData- Returns:
- int Returns a int
-
setPortState
Information provided by the PKI file:
\brief Sets the profile type. \param state, the port state to use. states: eFaulty = 0, eInit = 1, eDisabled = 2, eListening = 3, eUncalibrated = 4, ePreMaster = 5, eSlave = 6, eMaster = 7, ePassive = 8- Specified by:
setPortStatein interfacePTPPortData- Parameters:
state- Takes in a parameter of state
-
getPortState
Information provided by the PKI file:
\brief Gets the port state. \return PortState, the profile type. Port states: eFaulty = 0, eInit = 1, eDisabled = 2, eListening = 3, eUncalibrated = 4, ePreMaster = 5, eSlave = 6, eMaster = 7, ePassive = 8- Specified by:
getPortStatein interfacePTPPortData- Returns:
- PortState Returns a PortState
-
getPortStateStr
Information provided by the PKI file:
\brief Returns the profile as a string. \return string, profile strings: "FAULTY", "INITIALIZING", "DISABLED", "LISTENING", "UNCALIBRATED", "PRE_MASTER", "SLAVE", "MASTER", "PASSIVE"- Specified by:
getPortStateStrin interfacePTPPortData- Returns:
- String Returns a String
-
setRecommendedPortState
Information provided by the PKI file:
\brief Sets the recommended port state. \param state, the port state to use. states: eFaulty = 0, eInit = 1, eDisabled = 2, eListening = 3, eUncalibrated = 4, ePreMaster = 5, eSlave = 6, eMaster = 7, ePassive = 8- Specified by:
setRecommendedPortStatein interfacePTPPortData- Parameters:
state- Takes in a parameter of state
-
getRecommendedPortState
Information provided by the PKI file:
\brief Gets the recommended port state. \return PortState, the profile type. Port states: eFaulty = 0, eInit = 1, eDisabled = 2, eListening = 3, eUncalibrated = 4, ePreMaster = 5, eSlave = 6, eMaster = 7, ePassive = 8- Specified by:
getRecommendedPortStatein interfacePTPPortData- Returns:
- PortState Returns a PortState
-
setDelayRequestInterval
public void setDelayRequestInterval(int num) Information provided by the PKI file:
\brief Sets the delay request interval. \param num, the delay time in seconds- Specified by:
setDelayRequestIntervalin interfacePTPPortData- Parameters:
num- Takes in a parameter of num
-
getDelayRequestInterval
public int getDelayRequestInterval()Information provided by the PKI file:
\brief Gets the delay request interval. \return int, the delay request interval time in seconds.- Specified by:
getDelayRequestIntervalin interfacePTPPortData- Returns:
- int Returns a int
-
setAnnounceReceiptTimeout
public void setAnnounceReceiptTimeout(int num) Information provided by the PKI file:
\brief Sets the announcement receipt timout time. \param num, the time.- Specified by:
setAnnounceReceiptTimeoutin interfacePTPPortData- Parameters:
num- Takes in a parameter of num
-
getAnnounceReceiptTimeout
public int getAnnounceReceiptTimeout()Information provided by the PKI file:
\brief Gets the announcement receipt timout time. \return int, the announcement receipt timout time.- Specified by:
getAnnounceReceiptTimeoutin interfacePTPPortData- Returns:
- int Returns a int
-
setAnnounceInterval
public void setAnnounceInterval(int num) Information provided by the PKI file:
\brief Sets the announcement interval time. \param num, the time.- Specified by:
setAnnounceIntervalin interfacePTPPortData- Parameters:
num- Takes in a parameter of num
-
getAnnounceInterval
public int getAnnounceInterval()Information provided by the PKI file:
\brief Gets the announcement interval time. \return int, the announcement interval time.- Specified by:
getAnnounceIntervalin interfacePTPPortData- Returns:
- int Returns a int
-
setSyncInterval
public void setSyncInterval(int num) Information provided by the PKI file:
\brief Sets the sync interval time. \param num, the time.- Specified by:
setSyncIntervalin interfacePTPPortData- Parameters:
num- Takes in a parameter of num
-
getSyncInterval
public int getSyncInterval()Information provided by the PKI file:
\brief Gets the sync interval time. \return int, the sync interval time.- Specified by:
getSyncIntervalin interfacePTPPortData- Returns:
- int Returns a int
-
setSyncWaitLimit
public void setSyncWaitLimit(long num) Information provided by the PKI file:
\brief Sets the sync interval wait limit. \param num, the wait.- Specified by:
setSyncWaitLimitin interfacePTPPortData- Parameters:
num- Takes in a parameter of num
-
getSyncWaitLimit
public int getSyncWaitLimit()Information provided by the PKI file:
\brief Gets the sync interval wait limit. \return int, the sync interval wait limit.- Specified by:
getSyncWaitLimitin interfacePTPPortData- Returns:
- int Returns a int
-
setSyncMsgCounter
public void setSyncMsgCounter(int value) Information provided by the PKI file:
\brief Sets the sync message counter. \param value, value to use.- Specified by:
setSyncMsgCounterin interfacePTPPortData- Parameters:
value- Takes in a parameter of value
-
incrementSyncMsgCounter
public void incrementSyncMsgCounter()Information provided by the PKI file:
\brief Increments the sync message counter.- Specified by:
incrementSyncMsgCounterin interfacePTPPortData
-
getSyncMsgCounter
public int getSyncMsgCounter()Information provided by the PKI file:
\brief Gets the sync message counter. \return int, value is the sync message count.- Specified by:
getSyncMsgCounterin interfacePTPPortData- Returns:
- int Returns a int
-
setDelayReqCounter
public void setDelayReqCounter(int num) Information provided by the PKI file:
\brief Sets the delay request counter. \param num, value to use.- Specified by:
setDelayReqCounterin interfacePTPPortData- Parameters:
num- Takes in a parameter of num
-
incrementDelayReqCounter
public void incrementDelayReqCounter()Information provided by the PKI file:
\brief Increments the delay request counter.- Specified by:
incrementDelayReqCounterin interfacePTPPortData
-
getDelayReqCounter
public int getDelayReqCounter()Information provided by the PKI file:
\brief Gets delay request count. \return int, the delay request count.- Specified by:
getDelayReqCounterin interfacePTPPortData- Returns:
- int Returns a int
-
setAnnounceSeqNum
public void setAnnounceSeqNum(double num) Information provided by the PKI file:
\brief Sets the announce sequence number counter. \param num, value to use.- Specified by:
setAnnounceSeqNumin interfacePTPPortData- Parameters:
num- Takes in a parameter of num
-
getAnnounceSeqNum
public double getAnnounceSeqNum()Information provided by the PKI file:
\brief Gets the announce sequence number. \return double, value is the announce sequence number.- Specified by:
getAnnounceSeqNumin interfacePTPPortData- Returns:
- double Returns a double
-
setSyncSeqNum
public void setSyncSeqNum(double num) Information provided by the PKI file:
\brief Sets the sync sequence number. \param num, value to use.- Specified by:
setSyncSeqNumin interfacePTPPortData- Parameters:
num- Takes in a parameter of num
-
getSyncSeqNum
public double getSyncSeqNum()Information provided by the PKI file:
\brief Gets the sync sequence number. \return double, value is the sync message count.- Specified by:
getSyncSeqNumin interfacePTPPortData- Returns:
- double Returns a double
-
setDecisionCode
Information provided by the PKI file:
\brief Sets the decision code. \param code, the code to use. codes: None = 0, M1 = 1, M2 = 2, M3 = 3, P1 = 4, P2 = 5, S1 = 6- Specified by:
setDecisionCodein interfacePTPPortData- Parameters:
code- Takes in a parameter of code
-
getDecisionCode
Information provided by the PKI file:
\brief Gets the recommended port state. \return DecisionCode, the profile type. Decision codes: None = 0, M1 = 1, M2 = 2, M3 = 3, P1 = 4, P2 = 5, S1 = 6- Specified by:
getDecisionCodein interfacePTPPortData- Returns:
- DecisionCode Returns a DecisionCode
-
setLastSyncSeqNum
public void setLastSyncSeqNum(double num) Information provided by the PKI file:
\brief Sets the last sync sequence number. \param num, value to use.- Specified by:
setLastSyncSeqNumin interfacePTPPortData- Parameters:
num- Takes in a parameter of num
-
getLastSyncSeqNum
public double getLastSyncSeqNum()Information provided by the PKI file:
\brief Gets the last sync sequence number. \return double, value is the last sync sequence number.- Specified by:
getLastSyncSeqNumin interfacePTPPortData- Returns:
- double Returns a double
-
setLastGeneralEventSeqNum
public void setLastGeneralEventSeqNum(double num) Information provided by the PKI file:
\brief Sets the last known general event sequence number. \param num, value to use.- Specified by:
setLastGeneralEventSeqNumin interfacePTPPortData- Parameters:
num- Takes in a parameter of num
-
getLastGeneralEventSeqNum
public double getLastGeneralEventSeqNum()Information provided by the PKI file:
\brief Gets the last general event sequence number. \return double, value is the last sync sequence number.- Specified by:
getLastGeneralEventSeqNumin interfacePTPPortData- Returns:
- double Returns a double
-
setBustEnabled
public void setBustEnabled(boolean enable) Information provided by the PKI file:
\brief Sets bust to be enabled or disabled. \param enable, true to enable, false to disable.- Specified by:
setBustEnabledin interfacePTPPortData- Parameters:
enable- Takes in a parameter of enable
-
isBustEnabled
public boolean isBustEnabled()Information provided by the PKI file:
\brief Gets bust enabled state. \return bool, returns true if bust is enabled, false if not.- Specified by:
isBustEnabledin interfacePTPPortData- Returns:
- boolean Returns a boolean
-
removeForeignMasterBySrcPortId
Information provided by the PKI file:
\brief Removes a foreign master by port. \param uuid, uuid to find for. \param portNum, port to find for. \return bool, value is true if the foreign master as removed, false if not.- Specified by:
removeForeignMasterBySrcPortIdin interfacePTPPortData- Parameters:
uuid- Takes in a parameter of uuidportNum- Takes in a parameter of portNum- Returns:
- boolean Returns a boolean
-
clearForeignMasterList
public void clearForeignMasterList()Information provided by the PKI file:
\brief Removes all the foreign masters.- Specified by:
clearForeignMasterListin interfacePTPPortData
-
setEBestSrc
public void setEBestSrc(boolean value) Information provided by the PKI file:
\brief Sets the port data to be or not to be the best source for grandmaster clock \param value, true if the port data is the best source for grandmaster clock and false otherwise.- Specified by:
setEBestSrcin interfacePTPPortData- Parameters:
value- Takes in a parameter of value
-
isEBestSrc
public boolean isEBestSrc()Information provided by the PKI file:
\brief Check if this port data is the best source for grandmaster clock \return value, true if it is and false otherwise.- Specified by:
isEBestSrcin interfacePTPPortData- Returns:
- boolean Returns a boolean
-
resetDatasetToDefault
public void resetDatasetToDefault()Information provided by the PKI file:
\brief Resets the data set to default.- Specified by:
resetDatasetToDefaultin interfacePTPPortData
-
cancelTimer
public void cancelTimer()Information provided by the PKI file:
\brief Cancels the timer.- Specified by:
cancelTimerin interfacePTPPortData
-
clearConfig
public void clearConfig()Information provided by the PKI file:
\brief Clears the config.- Specified by:
clearConfigin interfacePTPPortData
-